Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx may not generate an api folder #799

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

lod
Copy link

@lod lod commented Jun 20, 2024

Trivial fix for a bug with simple projects where sphinx does not generate a docs/build/html/api/ folder. Without this fix the rename fails because the output_path does not exist.

Fix a bug for simple projects where sphinx does not generate a docs/build/html/api/ folder.  Without this fix the rename fails because the output_path does not exist.
@adiroiban
Copy link
Member

Hi David,

Thanks for the PR.

Can you please add more details about this use case?

Why is Sphinx not generating the API sub-folder ?

If Sphinx is not generating the API sub-folder, it looks like you are not using the pydoctor extension as designed.

If this is a valid use case, we also need documentation and automated test for this to make sure this feature is supported in future versions.

Regards

@tristanlatr
Copy link
Contributor

Hello, this seems related to #728, which I cannot figure out! So if this check fixes the issue I’m very very happy.

Did you find a minimal reproducer for this issue ? We should really have a test for this, would it possible to add it ?

Thanks a lot.

@tristanlatr
Copy link
Contributor

tristanlatr commented Jun 20, 2024

You can check the pr #742 in which I added some sphinx extension test in the hope to find a reproducer but I did not managed.

Copy link

codecov bot commented Jun 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.56%. Comparing base (dca9625) to head (21ca88c).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #799      +/-   ##
==========================================
- Coverage   92.62%   92.56%   -0.06%     
==========================================
  Files          47       47              
  Lines        8393     8393              
  Branches     1850     1850              
==========================================
- Hits         7774     7769       -5     
- Misses        356      359       +3     
- Partials      263      265       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tristanlatr
Copy link
Contributor

Hi @lod, did you managed to get an actual reproducer for that issue?

@tristanlatr
Copy link
Contributor

Hello @lod, have you been able to pin point why Sphinx might not generate the api folder?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants